/**
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program. If not, see <http://www.gnu.org/licenses/>.
 */
package org.merak.core.model.settings;

import java.util.Collections;
import java.util.LinkedList;
import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;


/**
 * Copyright © 2010-2012 Merak Computing. All rights reserved.<br><br>
 *
 * A Plugin Set is a container for plugins. It has settings that allow us to plug providers
 * into their respective services. It supports declaration of properties for each provider.
 * TODO Add watch dog for settings files, allowing supports for Plug and Play.
 *
 * @author fmarinho.
 * @version 1.00.00 - Aug 27, 2012 - fmarinho - initial version.
 *
 * @since MerakCore 1.00.00
 */
@XmlAccessorType(XmlAccessType.FIELD)
public class PluginSet implements ISettings<PluginSet> {

	@XmlAttribute private String       spiPackage = null;
	@XmlElement   private List<Plugin> plugin     = new LinkedList<Plugin>();

	/**
	 * The java package where to lookup for Service Provider Interfaces (SPI)
	 * @since v 1.00.00
	 */
	public String getSpiPackage() {
		return this.spiPackage;
	}

	/**
	 * The settings object containing the list of plugins.
	 * @since v 1.00.00
	 */
	public List<Plugin> getPlugin() {
		return Collections.unmodifiableList(this.plugin);
	}

	/* (non-Javadoc)
	 * @see org.merak.core.settings.ISettings#update(org.merak.core.settings.ISettings)
	 */
	@Override
	public void update(PluginSet source) {

		this.spiPackage = source.spiPackage;

		this.plugin.clear();
		this.plugin.addAll(source.plugin);

	}

}
